home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / BACKUP / DSKND102.ZIP;1 / DISKINDX.DOC < prev    next >
Encoding:
Text File  |  1993-04-13  |  24.9 KB  |  635 lines

  1.                                 DiskIndx v 1.02
  2.  
  3.                       Copyright 1991-1993 by JN Goodale
  4.  
  5.                         _______
  6.                    ____|__     |                (R)
  7.                 --|       |    |-------------------
  8.                   |   ____|__  |  Association of
  9.                   |  |       |_|  Shareware
  10.                   |__|   o   |    Professionals
  11.                 -----|   |   |---------------------
  12.                      |___|___|    MEMBER
  13.  
  14.  
  15.  
  16.  
  17.                                TABLE OF CONTENTS
  18.  
  19.  
  20.              I    General
  21.                      Description ......................... 1
  22.                      Volume Labels ....................... 1
  23.                      Starting up ......................... 1
  24.  
  25.              II   Menus
  26.                      Main Menu ........................... 2
  27.                      Search .............................. 2
  28.                      Add Volume to index file ............ 2
  29.                      Volume list ......................... 3
  30.                      Update/Display setup ................ 3
  31.                      Remove volume from index ............ 4
  32.                      Print ............................... 4
  33.                      Quit ................................ 4
  34.  
  35.              III  Details
  36.                      Volume Label description ............ 5
  37.                      Overflow ............................ 5
  38.                      Index file description .............. 6
  39.                      Requirements ........................ 7
  40.                      Limitations ......................... 7
  41.  
  42.              IV  Error Messages .......................... 8
  43.  
  44.              V   Registration/Support
  45.                      Support ............................. 10
  46.                      Registration ........................ 10
  47.                      Shareware concept/Ombudsman ......... 10
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                         i
  65.      I  GENERAL
  66.  
  67.  
  68.          DESCRIPTION:
  69.  
  70.              Program to create an index of files stored on floppy disks.
  71.              The index can then be searched to locate the diskette (by
  72.              volume label) where a specific file is stored.
  73.  
  74.          VOLUME LABELS:
  75.  
  76.              The key to indexing is using Volume Labels, both internal and
  77.              external.  You can label diskettes when you format them with
  78.              the /V option (DOS 3.x and below), or add them later with the
  79.              LABEL command.  Obviously, the internal label (written to the
  80.              diskette) and the external label (the one you hand write on the
  81.              outside) should be the same for this system to do you any good.
  82.  
  83.              See VOLUME LABEL DESCRIPTION  in Section III.
  84.  
  85.  
  86.          STARTING UP:
  87.  
  88.              DISKINDX - for color monitors
  89.              DISKINDX/M - to force monochrome display
  90.  
  91.                  (UPPER/lower case is not important)
  92.  
  93.  
  94.  
  95.              The program displays a path-name (which happens to be your
  96.              current path) which you may accept or change.  This is the path
  97.              where it expects to find (or create) data files, with the
  98.              extension ".!01".  This is the extension used by the program
  99.              for any files you create with DiskIndx.
  100.  
  101.              If you enter a different path-name, be sure to space out left
  102.              over characters, if any.  Then hit [ENTER].
  103.  
  104.              If the program does not find any "*.!01" it assumes you are
  105.              starting from scratch and gives you the standard options of
  106.              quitting, stating a NewPath, naming an index file, or using the
  107.              default name "DISKINDX.!01".
  108.  
  109.              If the program does find "*.!01" files it gives you the option
  110.              of quitting, stating a NewPath, naming an index file and a list
  111.              of all "*.!01" files.  Select the file or option of your
  112.              choice.  If you select a file from the list, the Main Menu will
  113.              appear.  If this is a new file, you are automatically taken to
  114.              the "Change/Update Setup" screen where you designate which
  115.              drive(s) you will use for indexing.
  116.  
  117.              Then you're ready to go.  A description of each menu follows in
  118.              the next section.
  119.  
  120.  
  121.                                         Page 1
  122.      II  MENUS
  123.  
  124.  
  125.          MAIN MENU options:
  126.  
  127.              The Main Menu Options are:
  128.  
  129.                          Search
  130.                          Add Volume to index file
  131.                          Volume list
  132.                          Update/Display setup
  133.                          Remove volume from index
  134.                          Print
  135.                          Quit
  136.  
  137.              A brief description of each option follows.
  138.  
  139.  
  140.              Search -
  141.              ------
  142.              You can search on:
  143.                  Volume Name (up to 11 characters)
  144.                  File Name (up to 8 characters)
  145.                  Extension (up to 3 characters)
  146.                      or
  147.                  Return to Main Menu
  148.  
  149.                  Search will match to the first "n" characters you input.
  150.                  If you enter "E" as the search string, then all items
  151.                  starting with "E" will match.
  152.  
  153.                  If you enter nothing, all files are displayed.
  154.  
  155.                  [ESC] will take you out of the display and back to the
  156.                  main menu.
  157.  
  158.              Add volume to index file -
  159.              ------------------------
  160.                  This option creates and/or adds to your current index file.
  161.                  A "volume" is a diskette.
  162.                  It creates the index by volume label.
  163.                  If there is no volume label, it will create one and tell
  164.                      you what it is creating.  The label is written to the
  165.                      diskette, also.  If the diskette is "write protected"
  166.                      you are given options to Skip it, Re-try, or go ahead
  167.                      and add to the index, but don't write a label on the
  168.                      diskette.
  169.                  If you have previously indexed this diskette (known by its
  170.                      volume name), it wipes out all previous entries and
  171.                      re-indexes the current one.
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.                                         Page 2
  179.              Volume list -
  180.              -----------
  181.                  This displays a "summary" of all volumes (diskettes).
  182.                  Information displayed is Volume name, number of
  183.                  directories, number of files, bytes used and bytes free.
  184.  
  185.                  The top of the display will show the following, AFTER you
  186.                  get to the last page of the Volume list:
  187.                          nnnn Max - Maximum number of entries allowed in
  188.                                      available memory.
  189.                          nnn Volumes - How many diskettes are indexed.
  190.                          nnn Dir - Total number of directories.
  191.                          nnnn Files - Total number of files indexed.
  192.                          nnnnnnnn Bytes - Total number of bytes on all
  193.                                           volumes.
  194.  
  195.                          Right under Max is "nnnn Entries used".  This is
  196.                              the number of entries currently being used in
  197.                              the program.  If you have not deleted any
  198.                              entries (described later) or re-indexed an
  199.                              existing file, that number will be = # Volumes
  200.                              + # Files +1.
  201.  
  202.                              If you have deleted or re-indexed volumes
  203.                              during the current session, the number will be
  204.                              larger.  If you exit and read the file in
  205.                              fresh, it will be as above.
  206.  
  207.              Update/Display setup -
  208.              --------------------
  209.                  Allows you to change the drive you use for indexing.  Two
  210.                  drives are allowed.  If BOTH are "A", then you will use
  211.                  drive A only.  If both are "B" then you will use drive B
  212.                  only.  Or you can flip/flop between A and B.
  213.  
  214.                  When you "Quit", this information is saved with the file.
  215.  
  216.                  It can be changed anytime during running of the program.
  217.                  If you have an "A" drive and "B" drive that are not the
  218.                  same size, and you want to index only from one drive, you
  219.                  may do so by changing your "SETUP" on the fly.  That is,
  220.                  [ESC] from "Add Disk Files", elect option to "Update/
  221.                  Display Setup", change it, then go back to "Add Volume to
  222.                  Index" option.
  223.  
  224.                  This screen also displays the status of the number of entries
  225.                  used and the maximum allowable.
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.                                         Page 3
  236.              Remove volume from index -
  237.              ------------------------
  238.                  You are given a list of all volumes indexed.  Point to the
  239.                  one to remove and hit [ENTER].
  240.  
  241.                  If you intend to re-index the same volume name, you DON'T
  242.                  need to remove it first.  The program will delete all
  243.                  previous references to a re-indexed diskette.
  244.  
  245.                  If you have "eliminated" some diskette, or given it a new
  246.                  volume label, then you would want to use this option.
  247.  
  248.                  Removed volumes will appear as spaces.  Hit [ESC] to Quit
  249.                  the option.  Next time, deleted volumes will not appear on
  250.                  the list.
  251.  
  252.              Print -
  253.              -----
  254.                  Output goes to printer.
  255.                  Options are:
  256.                      Volume List Summary - prints essentially the same
  257.                       information that the "Volume list" option displays on
  258.                       the screen.
  259.                      Sequence by Vol/Dir/File - sorts and prints all
  260.                        entries.
  261.                      Sequence by Filename/Ext - sorts and prints all
  262.                        entries.
  263.                      Sequence by Ext - sorts and prints all entries.
  264.  
  265.                  Except for the Volume List Summary, this option can take a
  266.                  lot of paper and print ribbon if you have a large index
  267.                  file.
  268.  
  269.              Quit - (You can also "Quit" by hitting [ESC])
  270.              ----
  271.                  If there have been any updates to the file, it will be
  272.                  sorted and saved.  Deleted entries are NOT saved.
  273.  
  274.                  Sorting takes the most time.  Be patient.
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.                                         Page 4
  293.      III   DETAILS
  294.  
  295.      VOLUME LABEL DESCRIPTION:
  296.  
  297.              The program will also write labels for you, if you prefer.
  298.      Just remember to write the external label on the disk that the program
  299.      assigns (it tells you when it does it).
  300.  
  301.      However, the labels the program writes won't hold a lot of meaning for you.
  302.      The first one it writes will be "VOL00000001", the next one will be
  303.      "VOL00000002", and so on. It only writes labels to diskettes that are not
  304.      already labeled.
  305.  
  306.      You may or may not have a meaningful scheme for labeling your diskettes
  307.      (such as BASIC001, BASIC002, LOTUS001, BACKUPC0001, etc.) but the program
  308.      generation of "VOLnnnnnnnn" is not very creative.  However, it is there for
  309.      labeling every one if you wish, and at the least it will write a label for
  310.      you and index the diskette until you get around to doing it later.
  311.  
  312.      PLEASE NOTE that the program keeps track of the labels it has created for
  313.      each "index" file separately.  If you decide to create two index files,
  314.      such as "SHARWARE.!01" where you keep the index of all shareware diskettes,
  315.      and another as "PUBLIC.!01" where you keep and index of all public domain
  316.      diskettes, each will label the first diskette it finds without a label as
  317.      "VOL00000001". The first record on each index file stores this information,
  318.      so each index file is a separate system. If you have enough memory in your
  319.      computer and not more than about 7700 files total, you won't need more than
  320.      one index file anyway. These 7700 files could be on any number of disks.
  321.  
  322.      OVERFLOW
  323.  
  324.      If You reach the maximum number of entries that your memory will allow
  325.      (while "Adding" diskettes to the index) you will get the "File is full"
  326.      message mentioned above.  Hit [ENTER] to let the program try to find
  327.      "deleted" entries to remove to make more room.  While this is going on you
  328.      will see the message "Removing 'deleted' entries ..".  When it is finished
  329.      you will get the message "There is now room for nnn more entries".
  330.  
  331.      Unless a lot of room was freed up (due to previously reindexing some
  332.      existing diskettes or using the "Remove Volume from index" option),
  333.      there should not be many free slots.  Your best bet is to [ESC] to Quit
  334.      and start a new index.
  335.  
  336.      When this happens, these are your options (after exiting the program):
  337.  
  338.          1.  Create another index file - You can have up to 32 on one path
  339.          2.  Clean house - Get rid of files you don't need
  340.          3.  Get more memory (if you have less than 640K)
  341.  
  342.      *** NOTE ***
  343.              During the process of adding diskettes you can easily check on
  344.              the status of how many entries you have used and compare it to
  345.              the maximum allowed by periodically going to the
  346.              "Update/Display Setup" option, which provides this information.
  347.  
  348.  
  349.                                         Page 5
  350.          INDEX FILE descripton:
  351.  
  352.              The index file is created with the extension ".!01", which
  353.              should be a fairly unique extension not likely to be found
  354.              already on your system.  The first 8 characters can be any name
  355.              you choose.  If you are just starting up, the program provides
  356.              the name DISKINDX.!01 as a starter, but you don't have to use
  357.              it.
  358.  
  359.              The file is made up of one record for every file it finds on a
  360.              diskette, as follows:
  361.  
  362.                     Record 1 (Configuration record)
  363.                     -------------------------------
  364.  
  365.                     Pos 01-11  "!    Config"
  366.                         12-19  Last number used to label a diskette
  367.                            20  Blank
  368.                         21-28  File Name of current file
  369.                         29-40  Blank
  370.                         45-52  Date the index file was updated
  371.                            53  First drive used for indexing (default=A)
  372.                            54  Blank
  373.                            55  Second drive used for indexing (default=A)
  374.  
  375.                     Records 2 through end
  376.                     ---------------------
  377.  
  378.                     Pos 01-11  Volume Name
  379.                         12-44  Directory (if any - only up to 33 char)
  380.                         45-52  File Name
  381.                         53-55  File Extension
  382.                            56  File Attribute
  383.                         57-60  File Date
  384.                         61-64  File Size
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.                                         Page 6
  407.          REQUIREMENTS:
  408.  
  409.                 IBM Compatible computer
  410.                 Monochrome or Color monitor
  411.                 1 Floppy Drive (MUCH better if you also have a HardDrive).
  412.                 Printer (optional)
  413.                 DOS 2.11 or higher
  414.                 256K memory
  415.  
  416.  
  417.          LIMITATIONS:
  418.  
  419.                 Limited to 32 index files on one path.
  420.  
  421.                 The number of entries (one entry per filename indexed)
  422.                 allowed is based on how much main memory (up to 640K) you
  423.                 have.  The following table is a very rough estimate of how
  424.                 many files you could handle in one index based on about 80K
  425.                 of system overhead:
  426.  
  427.                           Memory              Max # of Files
  428.                            256 K                 1700
  429.                            384 K                 3700
  430.                            512 K                 5700
  431.                            640 K                 7700
  432.  
  433.                 As you can see, it is 2000 files per 128 K, which makes
  434.                 sense since each entry is a 64 character record.
  435.  
  436.                 Assuming you have 640 K and you have an average of 100 files
  437.                 per diskette, you could index 77 diskettes on one "index
  438.                 file".  On the same path you can have 32 "index files", so
  439.                 could have within easy reach the index of 2,464 diskettes,
  440.                 or 246,400 files.
  441.  
  442.                 If you use 360 K diskettes to hold the index file, you are
  443.                 limited to about 5500 entries due to diskette space
  444.                 limitations.
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.                                         Page 7
  464.      IV    ERROR MESSAGES (Alphabetical sequence)
  465.  
  466.              Bad File Name entered
  467.              ---------------------
  468.                  Cause:  After selecting the "New File" option, you entered
  469.                     a file name with an extension.  Do NOT enter an
  470.                     extension.  Enter only the Base Name, which can be up to
  471.                     8 characters.
  472.                  Response:  Enter a proper file name and hit [ENTER].
  473.  
  474.              Disk is write-protected
  475.              -----------------------
  476.                  Cause:  Program is trying to write a label to a write-
  477.                      protected diskette.  This only happens when the
  478.                      diskette doesn't have a label to begin with.
  479.                  Response:
  480.                      Hit [ENTER] and you will be given some options.  They
  481.                        are:
  482.  
  483.                          [ENTER] - Try again.  But FIRST, remove the write-
  484.                              protect tab.
  485.                          [S] - Skip.  Ignore this diskette.  Remove it and
  486.                              put another one in.
  487.                          [ESC] - Bail out.  Back to main menu.  Also ignores
  488.                              this diskette.
  489.                          [SPACEBAR] - Indexes the diskette, but doesn't try
  490.                              to write a label.  This allows you to index a
  491.                              diskette with permanent write-protection and no
  492.                              internal label.
  493.  
  494.  
  495.              File is full - will remove deleted entries
  496.              ------------------------------------------
  497.                  Cause:  The Maximum number of entries will be exceed when
  498.                      the current directory of the current diskette is
  499.                      indexed.
  500.                  Response:  The program will remove deleted entries and then
  501.                      report to you how many entries are available.  Try
  502.                      again, if you think there are plenty of entries left.
  503.                      If you get the same message again, then [ESC].
  504.  
  505.                      Please note that the diskette that caused the overflow
  506.                      has NOT been indexed.
  507.  
  508.                  See OVERFLOW - Section II.
  509.  
  510.              File won't fit in memory - - [ESC] to Quit
  511.              ------------------------------------------
  512.                  Cause:  Created file on a bigger computer, or have more
  513.                      "overhead" loaded.  Now can't read the whole file into
  514.                      the memory remaining.
  515.                  Response: [ESC] will Quit and do nothing.
  516.                            [ENTER] will take what it can and drop the rest.
  517.  
  518.  
  519.  
  520.                                         Page 8
  521.              Invalid Path
  522.              ------------
  523.                  Cause:  Path doesn't exits.
  524.                  Response:  You get another chance to enter a valid path.
  525.                      Make sure the drive letter is correct.
  526.  
  527.              Not a valid drive letter
  528.              ------------------------
  529.                  Cause:  During "SETUP" you entered something other than "A"
  530.                     or "B", or you entered "B" but don't have a "B" drive.
  531.                  Response:  Change to a valid drive letter.
  532.  
  533.              Not enough memory to work with
  534.              ------------------------------
  535.                  Cause:  Your computer does not have enough memory to hold a
  536.                     file array of even one element.  The file is created in
  537.                     memory and there needs to be enough memory to hold the
  538.                     file array.
  539.                  Response: The program ends.
  540.  
  541.              Removing 'deleted' entries
  542.              --------------------------
  543.                  See OVERFLOW - Section III.
  544.  
  545.              There is now room for nnn more entries
  546.              --------------------------------------
  547.                  See OVERFLOW - Section III.
  548.  
  549.              This is NOT and index input file
  550.              --------------------------------
  551.                  Cause:  A file on your current path has the extension
  552.                    ".!01" and you selected it, but it was not created by
  553.                    DISKINDX and could blow the program if read in.  This
  554.                    could happen if you re-name some unrelated file and give
  555.                    it the extension ".!01".  The program expects to find "!
  556.                    Config" in the first field of the first record, and if
  557.                    that isn't found, you get this message.
  558.                  Response:  You are taken back to the file selection screen.
  559.                    Choose a different file.
  560.  
  561.              Too many "*.!01" selections on this path
  562.              ----------------------------------------
  563.                  Cause:  There are over 32 files with the extension "!01" on
  564.                     the currently selected path.  This is an absolute
  565.                     limitation due to program structure.  32 separate index
  566.                     files SHOULD be sufficient.  If not, then put them on a
  567.                     different directory.
  568.                  Response:  Program goes to Path selection.  Enter a
  569.                     different path name, then exit and delete some files,
  570.                     rename them with another extension, or put them on a
  571.                     different directory (or drive).
  572.  
  573.  
  574.  
  575.  
  576.  
  577.                                         Page 9
  578.      V   SUPPORT/REGISTRATION
  579.  
  580.              SUPPORT
  581.  
  582.              I will provide support for registered owners for six months.
  583.              This includes free fixes for program bugs and notification of
  584.              future enhancements.
  585.  
  586.              If you have questions, problems, or comments, I can be reached
  587.              at:
  588.                      JN Goodale
  589.                      7826 Littlejohn Court
  590.                      Charlotte,  NC  28227
  591.                      (704)-537-0329
  592.                      CompuServe ID  71116,302
  593.  
  594.  
  595.              REGISTRATION
  596.  
  597.                 You may become a registered owner by completing the attached
  598.                 registration form and sending it to me along with $15.
  599.  
  600.                 Registration provides you with:
  601.                         1] Support
  602.                         2] Notification of upgrades
  603.                         3] Latest version with reference to "UnRegistered"
  604.                            removed.
  605.                         4] FREE copy of HARDINDX, a hard drive indexer.
  606.  
  607.      VI  SHAREWARE CONCEPT/OMBUDSMAN INFORMATION
  608.  
  609.         Shareware distribution gives users a chance to try software
  610.         before buying it.  If you try a Shareware program and continue
  611.         using it, you are expected to register.
  612.  
  613.         Shareware is a distribution method, not a type of software.  You
  614.         should find software that suits your needs and pocketbook, whether
  615.         it's commercial or Shareware.  The Shareware system makes fitting
  616.         your needs easier, because you can try before you buy.  And because
  617.         the overhead is low, prices are low also.  Shareware has the
  618.         ultimate money-back guarantee -- if you don't use the product,
  619.         you don't pay for it!
  620.  
  621.  
  622.                Association Of Shareware Professionals Ombudsmen
  623.  
  624.         This program is produced by a member of the Association of
  625.         Shareware Professionals (ASP).  ASP wants to make sure that the
  626.         shareware principle works for you.  If you are unable to resolve a
  627.         shareware-related problem with an ASP member by contacting the
  628.         member directly, ASP may be able to help.  The ASP Ombudsman can
  629.         help you resolve a dispute or problem with an ASP member, but does
  630.         not provide technical support for members' products.  Please write
  631.         to the ASP Ombudsman at P.O. Box 5786, Bellevue, WA 98006 or send
  632.         a Compuserve message via easyplex to ASP Ombudsman 70007,3536
  633.  
  634.                                         Page 10
  635.